Namespaces

Types in MathNet.Numerics.LinearAlgebra.Solvers

Type IterationCountStopCriterion<T>

Namespace MathNet.Numerics.LinearAlgebra.Solvers

Interfaces IIterationStopCriterion<T>

Defines an IIterationStopCriterion<T> that monitors the numbers of iteration steps as stop criterion.

Constructors

Methods

Properties

Fields

Public Constructors

IterationCountStopCriterion<T>()

Initializes a new instance of the IterationCountStopCriterion<T> class with the default maximum number of iterations.

IterationCountStopCriterion<T>(int maximumNumberOfIterations)

Initializes a new instance of the IterationCountStopCriterion<T> class with the specified maximum number of iterations.
Parameters
int maximumNumberOfIterations

The maximum number of iterations the calculation is allowed to perform.

Public Methods

IIterationStopCriterion<T> Clone()

Clones the current IterationCountStopCriterion<T> and its settings.
Return
IIterationStopCriterion<T>

A new instance of the IterationCountStopCriterion`1 class.

IterationStatus DetermineStatus(int iterationNumber, Vector<T> solutionVector, Vector<T> sourceVector, Vector<T> residualVector)

Determines the status of the iterative calculation based on the stop criteria stored by the current IterationCountStopCriterion<T>. Result is set into Status field.
The individual stop criteria may internally track the progress of the calculation based on the invocation of this method. Therefore this method should only be called if the calculation has moved forwards at least one step.
Parameters
int iterationNumber

The number of iterations that have passed so far.

Vector<T> solutionVector

The vector containing the current solution values.

Vector<T> sourceVector

The right hand side vector.

Vector<T> residualVector

The vector containing the current residual vectors.

bool Equals(object obj)

int GetHashCode()

Type GetType()

void Reset()

Resets the IterationCountStopCriterion<T> to the pre-calculation state.

void ResetMaximumNumberOfIterationsToDefault()

Returns the maximum number of iterations to the default.

string ToString()

Public Properties

int MaximumNumberOfIterations get; set;

Gets or sets the maximum number of iterations the calculation is allowed to perform.

IterationStatus Status get;

Gets the current calculation status.

Public fields

int DefaultMaximumNumberOfIterations

The default value for the maximum number of iterations the process is allowed to perform.
return int